home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / renegade / rgep261.zip / RGEP.EXE / RGE.DOC < prev    next >
Text File  |  1994-06-12  |  22KB  |  469 lines

  1.  
  2.                            Renegade Editor
  3.                  is Copyright 1994 by Patrick Spence
  4.                          All Rights Reserved
  5.  
  6.                Renegade is copyright 1994 by Cott Lang.
  7.  
  8.     This set of programs, and all of its accompanying files excluding
  9.     FileIN and FileINs associate files are Copyright 1994 by Patrick
  10.     Spence, all rights are reserved.  FileIN is copyright 1994 by Chris
  11.     Roberts, all rights reserved.
  12.  
  13.     You are granted the limited license to evaluate this program on ONE
  14.     computer for a period of 21 days.  IF by the end of the 21 day
  15.     evaluation period you decide that it is not worth registering, then you
  16.     must cease using the program, and remove all unarchived copies of it
  17.     from your system.  You may still distribute the distribution archive.
  18.  
  19.     Under no condition are you allowed to edit, modify, reverse engineer,
  20.     or otherwise change the files in the distribution archive (excepting
  21.     archival purposes).  Such actions constitute a license violation, and
  22.     your license to use RGE is immediately revoked.  You do not need to use
  23.     an executable file compressor such as LZExe, PKLite or ExePack, since
  24.     the program has been compressed and protected, and -ANY FURTHER
  25.     MODIFICATIONS WILL CAUSE THE PROGRAM TO CEASE FUNCTIONING-.
  26.  
  27.     You may freely distribute the distribution archive as LONG AS you do
  28.     NOT add any files (especially BBS advertisements) to the archive, or
  29.     modify any of the files in the archive.
  30.  
  31.     Plus, if you find an archive that has an advertisement added to it,
  32.     send it to me, and if I can validate that an advertisement or other
  33.     file was added without permission, (and assuming no one has reported
  34.     that particular one before you), you may receive a discount on
  35.     registering Renegade Editor, or credit towards registering OTHER
  36.     KludgeWare! files.
  37.  
  38.     Registration gives you the limited license to run one copy of this
  39.     program at a time, on ONE machine at a time.  Ergo, no more than one
  40.     copy may be in use at a given time.  The registration key remains the
  41.     property of Patrick Spence, and you may not transfer it, give it away,
  42.     nor distribute it without explicit permission from Patrick Spence.
  43.  
  44.     If you wish to purchase a site license, or other type of usage
  45.     agreement that is different than stated here, send me a letter
  46.     detailing what you want, and I will give you the terms for the
  47.     agreement.
  48.  
  49.  ┌───────────────────────────────────────────────────────────────────┐
  50.  │ WARRANTY/GUARANTEE                                                │
  51.  └───────────────────────────────────────────────────────────────────┘
  52.  
  53.     None.  I have made every effort to make this program as safe as
  54.     possible, but there will always be that one situation that I cannot
  55.     test on my machine, or on the machines of my beta testers. So, this
  56.     program is only guaranteed to take up space on your drive.
  57.  
  58. ! WARNING ! ! WARNING ! ! WARNING ! ! WARNING ! ! WARNING ! ! WARNING !
  59.  
  60.     This program is intended for Renegade sysops who have a modicum of
  61.     experience with Renegade, and WHO MAKE BACKUPS ON A REGULAR BASIS!
  62.  
  63.     RGE -Will- be a dangerous program if you don't know what you are doing,
  64.     as it will let you do things and save changes without intervention
  65.     because it assumes that you know what you are doing.
  66.  
  67.     If you in any way fell uncomfortable with this program, and the
  68.     potential hazards, OR, if you do not make regular backups of your data
  69.     files, then DO NOT RUN THIS PROGRAM because I will NOT be responsible
  70.     for any damages that are done to your BBS as a result.
  71.  
  72.     YOU HAVE BEEN WARNED!
  73.  
  74. ! WARNING ! ! WARNING ! ! WARNING ! ! WARNING ! ! WARNING ! ! WARNING !
  75.  
  76.  ┌───────────────────────────────────────────────────────────────────┐
  77.  │ DISTRIBUTION                                                      │
  78.  └───────────────────────────────────────────────────────────────────┘
  79.  
  80.     This program may be freely distributed as LONG AS you do NOT add more
  81.     files to, or take files away from, or change any of the files in the
  82.     distribution archive.  ADVERTISEMENT FILES ARE EXPRESSLY FORBIDDEN FROM
  83.     BEING ADDED.
  84.  
  85.     Registered owners may NOT distribute their registration keys to anyone
  86.     without writen permission from Patrick Spence. Registered owners may
  87.     SELL their keys, but MUST notify Patrick Spence in writing that they
  88.     are transferring their key, as well as send a copy of the registration
  89.     form filled out with the information from the person that they are
  90.     selling it to (so that a new key can be generated)
  91.  
  92.  ┌───────────────────────────────────────────────────────────────────┐
  93.  │ REGISTRATION                                                      │
  94.  └───────────────────────────────────────────────────────────────────┘
  95.  
  96.     Registration of the RGE package is simple, fill out the accompanying
  97.     REGISTER.FRM and send it to me with $25.00 american at:
  98.  
  99.         Patrick Spence
  100.         P.O. Box 637
  101.         Apache Junction, AZ  85217-0637
  102.  
  103.     You will receive back a receipt with your registration key, and the
  104.     name used to generate it.  Type this name EXACTLY as it appears on the
  105.     form, or your registration key will not work.
  106.  
  107.     See the REGISTER.FRM file to see if any 'Early Bird' Specials are in
  108.     effect that will give you a reduction of costs.
  109.  
  110.     Registration entitles you to no cost upgrades to any future versions.
  111.     This means that in most cases, the registration will be valid across
  112.     versions, but in some cases, you will need to send me a small fee to
  113.     receive your upgrade.  This is entirely dependant on how much changes
  114.     across versions.
  115.  
  116.     No guarantees are made that there will be future releases, but I do not
  117.     see any immediate ceasation of production on at least SOME piece of
  118.     software.  I am working on more utilities to include, as well as more
  119.     features of the renegade editor.  No matter what, I will continue to
  120.     support the RGE package with assistance in using it, and possible bug
  121.     fixes as long as my computer operates. Registered users WILL get more
  122.     support and assistance than those who do not register.
  123.  
  124.  
  125.  ┌───────────────────────────────────────────────────────────────────┐
  126.  │ INSTALLATION                                                      │
  127.  └───────────────────────────────────────────────────────────────────┘
  128.  
  129.     It is advised that you dedicate a directory for RGE, but it is not
  130.     required.  You do not need to place it in the path, and you do not need
  131.     to place it in your Renegade directory.
  132.  
  133.     Run the RGECFG program that is provided in this package.  This program
  134.     will let you enter your path to your Renegade BBS, as well as customize
  135.     how the RGE looks (including 43/50 line mode on ega/vga machines).  If
  136.     you have registered the RGE package, this is also how you enter your
  137.     user name and registration key.
  138.  
  139.     When entering your user name and registration key, type them EXACTLY as
  140.     they appear on the registration certificate, case -IS- significant.
  141.  
  142.     To select an item to change, just scroll up and down and hit <Enter> on
  143.     the selection that you wish to change.  An editing field will pop up in
  144.     the lower window to allow you to change the item.
  145.  
  146.     While scrolling up and down, the right end of the Highlight bar will
  147.     have one of three arrows () to tell you if there is more options
  148.     above and below the current line.  This will also be how the scroll bar
  149.     works in the RGE program itself.
  150.  
  151.     This version of RGE does -NOT- have any crippled features, and for the
  152.     term of your trial testing period, it doesn't have any nag screens.
  153.     Some time after your trial registration, RGE will cease to operate,
  154.     requiring a registration.  Future releases will have restricted
  155.     features that you will not be able to access without registering the
  156.     RGE package.
  157.  
  158.     To run RGE, merely type in its name at the command line, or you could
  159.     install it to be called by one of your GLOBATx.BAT files, so you can
  160.     call it from inside Renegade with a function key.
  161.     
  162.     WARNING, Renegade does not currently reread the Renegade.dat upon
  163.     return from a shell, and as such, the changes you have made will not
  164.     necessarily be used until you open Renegades internal system
  165.     configuration option and exit it.
  166.  
  167.     RGE does no comm port communication, so you can only run it locally.
  168.  
  169.  ┌───────────────────────────────────────────────────────────────────┐
  170.  │ RUNNING RGE                                                       │
  171.  └───────────────────────────────────────────────────────────────────┘
  172.   ┌──────────────────────────┐
  173.   │ CONVENTIONS USED / NOTES │
  174.   └──────────────────────────┘
  175.     - Saving your changes:
  176.         When you edit an area, such as the strings, or the system
  177.         configuration, and you want the changes that you have made saved,
  178.         you MUST save them prior to returning to the main menu. If you
  179.         don't you will lose all of the changes that you have made.
  180.         
  181.         RGE will prompt you upon exit of each main section if you want to
  182.         save the changes or not.  If you select N it will abort the exit,
  183.         and will NOT save any changes.  If you select Y it will save
  184.         changes and then exit, and if you select A it will Abort any
  185.         changes you have made, and exit the section.
  186.  
  187.     - String Editing:
  188.         Strings are interactively edited, and you can use the following
  189.         command keys while doing so:
  190.  
  191.             Key                 Result
  192.             ─────────────────────────────────────────────────────────
  193.             Ins                 Toggles Insert/Overstrike mode RGE defaults
  194.                                 to Insert mode
  195.  
  196.             Home                Sends the cursor to the beginning of
  197.                                 the field
  198.  
  199.             Left Arrow          Moves the cursor one space left
  200.  
  201.             Right Arrow         Moves the cursor one space right
  202.  
  203.             Control-Backspace   Deletes entire field
  204.  
  205.             End                 Sends cursor to the end of the field
  206.  
  207.             Esc                 Returns string to previous value.  It will
  208.                                 remain editing the field, so you can easily
  209.                                 return to the values you had before you
  210.                                 started changing the string.
  211.  
  212.     - Moving among screens:
  213.         When moving among screens when editing multi screen data, such as
  214.         the archive configuration, the strings, and the protocols, you can
  215.         use the following keys:
  216.  
  217.             End                 Go to last active screen
  218.             Home                Go to the first active screen
  219.             Left Arrow          Moves one screen left
  220.             Right Arrow         Moves one screen right
  221.  
  222.  
  223.     - Color Translations:
  224.         RGE does NOT actively translate Renegade color codes, and this is a
  225.         FEATURE, not a bug.  The original impetus for writing this program
  226.         was to be able to interactively edit various strings in Renegade
  227.         interactively, and be able to change individual characters without
  228.         having to retype the whole string.
  229.         
  230.         If you want to see what a color translated version of any of the
  231.         strings will be, then simply hit <F10> while you are editing any of
  232.         the fields.  This will pop up a color translation screen that will
  233.         have the string displayed, as well as a listing of all the Pipe
  234.         codes, and the default ^x codes in the Renegade configuration.
  235.  
  236.     - Renegade and RGE:
  237.         Currently, -Renegade- does NOT re-read the Renegade.dat file upon
  238.         return from a shell such as a Globatx.bat or a Door drop file, so
  239.         if you use one of these to shell out to run RGE, your changes will
  240.         not be evident until you either exit Renegade or load up the system
  241.         config and exit it...if you do the latter, do not change anything
  242.         in the system config.  This is a hassle, but hopefully Cott will
  243.         reconfigure Renegade to re-read the Renegade.dat file upon return
  244.         from the shell. Until then, use some common sense, and keep track
  245.         of what you are doing.
  246.  
  247.     - MULTI TASKING WARNING!:
  248.         RGE support supports basic file sharing, but intellegence and care
  249.         must STILL be taken, since it goes beyond the range of ordinary
  250.         utilities, and as such, you can lose configured data if you are not
  251.         careful.
  252.         
  253.     - MESSAGE BASE AND FILE BASE EDITING:
  254.         RGE can now edit message and file bases.  The method used for this
  255.         uses a lot of RAM to work with, so some of you might not be able to
  256.         use this option.  You will need about 450k of conventional ram to
  257.         use this option.
  258.         
  259.         You can also only edit -1024- bases, the maximum number of bases RG
  260.         will support if you have base number compression on. If enough of
  261.         you actually have/use more than 1024 message or file bases, let me
  262.         know and I will work up a different method.
  263.  
  264.     - OVERLAYS
  265.         RGE uses overlays, this is so more people can use the message and
  266.         file base editing routines.  RGE will swap its overlays to EMS is
  267.         there is enough available, otherwise it will use conventional ram
  268.         for its overlays.
  269.         
  270.     - LOG FILE
  271.         RGE makes a text format log file giving the general activities that
  272.         were done in each RGE session.  The log file can be turned off in
  273.         the RGECFG program.
  274.  
  275.         The log is formatted like this:
  276.         
  277.  
  278. ----------  Thu, Apr 14, 1994  RGE
  279. > 01:10:50  The Renegade Editor is Copyright 1994 by Patrick Spence             
  280. > 01:10:50  All Rights Reserved                                                 
  281. > 01:10:50  Please read the documentation for full license agreement            
  282.  
  283. ----------  Sun, Apr 24, 1994  RGE
  284. ? 20:41:00  Using EMS for faster overlay swapping.                              
  285. | 20:41:00  Error number loading SCHEME.DAT is: 0                               
  286. > 20:41:13  Entering Protocol edit                                              
  287. < 20:41:16  Exiting Protocol edit                                               
  288. > 20:41:17  Entering Messagebase configuration.                                 
  289. < 20:41:23  Exiting Messagebase configuration.                                  
  290.   20:41:24  Normal Termination                                                  
  291.  
  292.  
  293.         The various character codes at the start of most lines are as
  294.         follows:
  295.         
  296.         ?  Warning of some sort
  297.         !  Fatal error
  298.         #  RGE had a question
  299.         -  Start of session
  300.         +  Creation of something
  301.         -  Destruction of something
  302.         @  Change of something
  303.         >  Entry to a section
  304.         <  Exit of a section
  305.         $  WHAT? you haven't Registered?
  306.         |  Debug statement (normally not in production code)
  307.  
  308.  ┌───────────────────────────────────────────────────────────────────┐
  309.  │ MESSAGE BASE TEMPLATE                                             │
  310.  └───────────────────────────────────────────────────────────────────┘
  311.  
  312.     There is now a message base template function, so that you may create a
  313.     template to use when inserting new message bases.  Using this you can
  314.     make it easier to add in a large number of similar bases (such as
  315.     echomail bases) to your configuration.
  316.  
  317.     This function is activated by the letter T from the main message base
  318.     editing screen.
  319.  
  320.     Included in this archive is a sample template, to use it just place it
  321.     in the same directory that you run RGE from, and when you enter the
  322.     message base area, it will prompt you for use of it.
  323.  
  324.  
  325.  ┌───────────────────────────────────────────────────────────────────┐
  326.  │ POST IT NOW AUTOMATIC POSTER                                      │
  327.  └───────────────────────────────────────────────────────────────────┘
  328.  
  329.     Another portion of the RGE package is an automatic message posting
  330.     program named PIN (or Post It Now).  PIN used to be distributed
  331.     separately, but is now part of the overall package.  Previous PIN
  332.     configuration files (PIN.CFG) will -not- work with this version.
  333.  
  334.     The maximum file size that you can post is approximately 64k in size.
  335.     This is due mainly to the limit of message size in Renegade. Pin
  336.     currently truncates the text file information at its size limit, though
  337.     future versions may just continue with another message.
  338.  
  339.     Remember though, that even though PIN will post a 60k text file into a
  340.     message, many mail processors (such as squish) have a lower limit on
  341.     the size of a message.
  342.  
  343.  ┌───────────────────────────────────────────────────────────────────┐
  344.  │ PIN AND FILEIN!                                                   │
  345.  └───────────────────────────────────────────────────────────────────┘
  346.  
  347.     Due to a cooperative effort, and a modular approach to programming,
  348.     FileIN by Chris Roberts now supports posting a message announcing files
  349.     to a renegade message base.  This posting is done via a shelled call to
  350.     PIN, so in order to take advantage of this feature of FileIN! you will
  351.     need to have Pin installed.
  352.  
  353.  
  354.  
  355.  ┌───────────────────────────────────────────────────────────────────┐
  356.  │ RUNNING PIN                                                       │
  357.  └───────────────────────────────────────────────────────────────────┘
  358.  
  359.  
  360.     Before PIN can be used, you must have an RGE.CFG file in the directory
  361.     that you run it from.  That way PIN can find the Renegade directory.
  362.  
  363.     Refer to previous sections of this documentation for more information
  364.     on creating a RGE.CFG file.
  365.  
  366.     PIN is operated quite easily, you create a text file that contains the
  367.     name of the file you want posted, the base name (as defined in
  368.     renegade), the subject of the message, who it is from and who it's to.
  369.     The format of the configuration file is as follows:
  370.     
  371. Line 1: <Who the message is from>
  372. Line 2: <Who the message is to>
  373. Line 3: <Subject of the message>
  374. Line 4: <Base name>
  375. Line 5: <file name/path to post>
  376.  
  377.     like this:
  378.  
  379. Your Sysop
  380. All
  381. Message Traffic
  382. announce
  383. tossrept.txt
  384.  
  385.     This can be repeated as many times in one file as you desire for
  386.     multiple posts in one run.  It is -VERY IMPORTANT- that you do not have
  387.     any empty lines, even at the end of the file, as it will cause an
  388.     error.  Any valid definitions before a bad line (such as a blank line,
  389.     or a forgotten line) will still be posted though.
  390.  
  391.     After creating this configuration file, you can then run PIN one of two
  392.     ways:
  393.     
  394. PIN <Configuration file>
  395. PIN
  396.  
  397.    The first option runs PIN, if there isn't a configuration file, it will
  398.    create one.  <Configuration file> is the text file of posting info.
  399.  
  400.    The Second option will display a short help screen.
  401.  
  402.    This method of specifying the configuration text file on the commandline
  403.    will allow you to have different messages posted at different times
  404.    (like weekly and monthly reports).
  405.  
  406.  
  407.  ┌───────────────────────────────────────────────────────────────────┐
  408.  │ FILEIN - FILES.BBS IMPORTER BY CHRIS ROBERTS                      │
  409.  └───────────────────────────────────────────────────────────────────┘
  410.  
  411.     The FileIN Files.bbs importer written by Chris Roberts is now being
  412.     distributed inside the RGE package (As well as separately). This is
  413.     being done in this manner, because we want to be able to bring you a
  414.     full complement of Renegade Utilities all in one package.
  415.  
  416.  
  417.  
  418.  ┌───────────────────────────────────────────────────────────────────┐
  419.  │ SUPPORT                                                           │
  420.  └───────────────────────────────────────────────────────────────────┘
  421.  
  422.     The RGE package is only supported directly by me in the ITC Renegade
  423.     base, Locally on my BBS, in netmail, or in snail mail to the same
  424.     address that you send registrations to.
  425.  
  426.                    Hawks Aerie BBS : (602) 873-2755
  427.                    14.4 - MNP 1..5 - V.32b - V.42b
  428.  
  429.                    ITC Net Address     : 85:20/0
  430.                    Fido Net Address    : 1:114/252
  431.                    Strange Net Address : 84:84/1
  432.                    Liberty Net Address : 76:48/42
  433.  
  434.  
  435.  ┌───────────────────────────────────────────────────────────────────┐
  436.  │ KUDOS                                                             │
  437.  └───────────────────────────────────────────────────────────────────┘
  438.  
  439.     Many thanks to my beta team, as well as those who have assisted in one
  440.     form or another to get this program released.
  441.  
  442.     KludgeWare! Beta Team: (Partial List)
  443.  
  444.         Bob Shields    - 85:823/200 @ ITC Net
  445.         Jerry Bursztyn - 84:62/200  @ Strange Net(tm)
  446.         Chris Roberts
  447.  
  448.     Assistance by: (Partial List)
  449.  
  450.         Cott Lang (Thanks Cott!)
  451.         Richard Rector
  452.         Frank Ward
  453.         Eric Kimmet
  454.         Jack Reece
  455.  
  456.  ┌───────────────────────────────────────────────────────────────────┐
  457.  │ ANTICIPATED FEATURES:                                             │
  458.  └───────────────────────────────────────────────────────────────────┘
  459.  
  460.     I am constantly working on more features for the RGE package, and
  461.     intend to ultimately include editing of ALL of the data files in
  462.     Renegade. Next on the listing is file ENTRY editing.
  463.  
  464.     I hope to have a 1-900 system set up to make it easier to register the
  465.     software that I write.  This will allow me to place an online
  466.     registration door up on my BBS to instantly give you a registration
  467.     Key.
  468.  
  469.